Skip to content

Add support for i18n in the cli #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 49 commits into from
Jun 1, 2020
Merged

Add support for i18n in the cli #676

merged 49 commits into from
Jun 1, 2020

Conversation

hdiniz
Copy link
Contributor

@hdiniz hdiniz commented Apr 24, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

  • What kind of change does this PR introduce?
    Using the function i18n.Tr("message", ...) its now possible to have localised messages in the cli.
    Localisation files are generated for each supported language.

  • What is the current behavior?
    No i18n support

  • What is the new behavior?
    To localise messages, use the function i18n.Tr. The message will be localised with the locale set via i18n.SetLocale(..)

  • Does this PR introduce a breaking change?
    No

  • Other information:

See how to contribute

cmaglie
cmaglie requested changes May 8, 2020
View reviewed changes
@hdiniz hdiniz requested a review from cmaglie May 15, 2020 14:27
hdiniz added 28 commits May 24, 2020 21:33
@hdiniz
add po message catalog implementation
ea0fa07
@hdiniz
add po parser for i18n cmd
818c40d
@hdiniz
add po merge function
d1103c2
@hdiniz
add command to generate en po file from source
d9f989e
@hdiniz
add command to update local po files with en catalog change
4fe2df2
@hdiniz
add task to generate po files
6b6d237
@hdiniz
add locale option for i18n
fcd0082
@hdiniz
add dependencies for i18n
602cd54
@hdiniz
add unit test for i18n
46cacf2
@hdiniz
add godoc to exported fields
a203de5
@hdiniz
add rice box for i18n messages
0c7be38
@hdiniz
add readme for i18n module
19dc9ef
@hdiniz
update README to add instruction to install go-rice
484ae8a
@hdiniz
remove warning log in case locale is not found
c9ac6b1
@hdiniz
add command to pull and push translation files from/to transifex
d3b957c
@hdiniz
remove unused import
ceb1e03
@hdiniz
dont generate new rice file if there are no translation changes
dd4f3fb
@hdiniz
add copyright headers
fa054dd
@hdiniz
use 'tr' function call as indicator for translations
74a7971
@hdiniz
adding documentation to pull,push translations and adding new languages
5879928
@hdiniz
push only the reference translation catalog
7628634
@hdiniz
add check on PR for updated catalog not commited
e09185a
@hdiniz
push message catalog to transifex
4560261
@hdiniz
pull translations fro transifex weekly
b29dd93
@hdiniz
get locale identifier from diferent OSes
94c6afd
@hdiniz
get locale identifier from diferent OSes
4d076f9
@hdiniz
match locale algo
ed9b523
@hdiniz
add locale match test
38b78aa
hdiniz added 21 commits May 24, 2020 21:34
@hdiniz
preserve LF in translation string unchanged
c977f8c
@hdiniz
init config before executing command
2d4b288
@hdiniz
create arduino cmd dynamically
749192d
@hdiniz
make all command init dynamically
968931d
@hdiniz
save all message occurrences in catalog
e4d201d
@hdiniz
add translatable cli usage template
cba0cf6
@hdiniz
add messages for cli usage template
56a0642
@hdiniz
remove standalone i18n message check
46af5e0
@hdiniz
add more i18n tests
ba1af89
@hdiniz
fix po parsing correctness and implement tests
6c8aa1e
@hdiniz
fix configuration path search tests
eec5609
@hdiniz
update catalog command to find go files
9007746
@hdiniz
update catalog with new path
2d3cf92
@hdiniz
fix docsgen command
4d6e353
@hdiniz
remove dependency on shell script for windows compat
2da2907
@hdiniz
fix test workflow
450aa60
@hdiniz
update setup-go to v2
98b8e16
@hdiniz
fail i18n:check task if catalog was not updated
672fc5e
@hdiniz
replace windows separator with forward slash
9ffa200
@hdiniz
use filepath function to translate windows paths
0d66bec
@hdiniz
only update en catalog
8e64833
cmaglie
cmaglie approved these changes May 26, 2020
View reviewed changes
Copy link
Member

@cmaglie cmaglie left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've tested:

  • task i18n:update (so tr(..) and i18n.Tr(..) calls detection)
  • task i18n:push and pull from transifex
  • PR sanity check on CI (checks fail if the submitter didn't run i18n:update)
  • various extreme conditions on missing translations
  • language setting detection on Linux

I did not test:

  • language settings detection on Windows and Mac
  • daily translation push to transifex
  • weekly translations pull from transifex into a PR

BTW I think that the above may be fixed in a later PR (if needed) after testing the whole system for a while.

@cmaglie cmaglie added this to the 0.11.0 milestone May 26, 2020
@cmaglie cmaglie self-assigned this May 26, 2020
rsora
rsora approved these changes Jun 1, 2020
View reviewed changes
Copy link
Contributor

@rsora rsora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@rsora rsora merged commit d53a15b into arduino:master Jun 1, 2020
@per1234 per1234 mentioned this pull request Feb 24, 2021
Closed
3 tasks
@per1234 per1234 mentioned this pull request Jul 28, 2021
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmaglie cmaglie cmaglie approved these changes

@rsora rsora rsora approved these changes

Assignees

@cmaglie cmaglie

Labels
None yet
Projects
None yet
Milestone
0.11.0
Development

Successfully merging this pull request may close these issues.
3 participants
@hdiniz @cmaglie @rsora